home *** CD-ROM | disk | FTP | other *** search
/ CD School House 9 / CD School House 9.0 - Wayzata Technology (1994).iso / pc / games / mac / __the_arcade__ / macman1_0_2 / macman1_0_2.docs
Text File  |  1992-03-20  |  8KB  |  195 lines
  1. DOCUMENTATION FOR MACMAN CLASSIC 1.0.1
  2. [this file looks best with 3-space tabs in Edit or the THINK C editor]
  3.  
  4. UPDATE
  5. Macman 1.0.2 is an update that fixes (finally) the speed problem, and adds 
  6. several new features.  Macman 1.0.1 was designed to fix a problem with the
  7. game being too fast on faster Macs (especially Quadras) but for fairly
  8. technical reasons the method used to do this was "fatally flawed." This time
  9. however a new method was used to ensure the same speed between Macs and a
  10. tweak option (to speed up or slow down the game) was added to provide
  11. further control.  See TECHNICALLY SPEAKING for a more thorough explanation.
  12. Using this method, no Slow Game option is necessary so there is only one
  13. Play menu choice.
  14.  
  15. Due to popular demand, a new dialog box allows you to customize the control
  16. keys (See Set Controls╔ under SETTINGS MENU) used to control macman.  In 
  17. addition, your choice of keys (among other things) is saved in a preferences
  18. file (actually in the resource fork of Macman) so that you don't have to
  19. reset them each time you start up the game.  If you are one of those who
  20. have stuck with Macman even though the speed problem continued to exist,
  21. thank you and my sincere apologies.
  22.  
  23. COMPATIBILITY
  24.  
  25. Macman was written on a Macintosh SE running System 6.0.7.  It should run on
  26. a Mac Plus or later without modification.  Because of calls made to the 
  27. Sound Manager, you probably need to be using System 6.0.x or higher. I have
  28. had one report that Macman crashed on a Mac Plus.  I am unable to test on
  29. a Plus, but one suggestion would be to keep the sound turned off (although
  30. System 6.0.7 should support the sound routines called by Macman).  With the
  31. sound off, earlier versions of Macman ran on a 512Ke without crashing, so I
  32. can't blame the 128k ROM.
  33.  
  34. I have had some problems with the sound.  Although the sine waves used to
  35. make most of the sound effects sound perfect on my SE, it sometimes is
  36. reduced to just a soft buzz on faster Macs.  Anyone know why?
  37.  
  38. It is compatible with MultiFinder (100K partition recommended) and System 
  39. 7.0.  If you find any compatibility problems please see how to contact the
  40. author below. 
  41.  
  42. It has been tested on a Mac SE (of course), a Mac IIci under System 7.0, a
  43. Mac II under System 7.0, and a Mac IIcx under System 7.0.
  44.  
  45. Macman 1.0.2 will no longer run on a Mac 512Ke (even with sound off) because
  46. of calls made to the revised time manager. (Revised Time Manager is 
  47. available only with System 6.0 or higher, which excludes the 512Ke.)
  48.  
  49. THE GAME
  50.  
  51. Most of you should already know how to play the game because it is
  52. remarkably similar to a famous arcade game.  The object of the game is to
  53. munch as many dots, energizers, vulnerable ghosts, and fruits as possible
  54. while avoiding ghosts who are not vulnerable.
  55.  
  56. An extra life is rewarded for every 15,000 points accumulated.
  57.  
  58. THE CONTROLS
  59.  
  60. The default controls are:
  61. [Y] up        [B] down        [G] left        [H] right
  62.  
  63. See Set Controls╔ to customize keys.  In addition, the space bar pauses the
  64. game.  After pausing, you can restart by hitting either the space bar or 
  65. any of the control keys.  Any click of the mouse will end a game currently 
  66. in progress.
  67.  
  68. THE MENUS
  69.  
  70.     APPLE MENU
  71.  
  72.     About Macman╔        gives you information on how to register your copy of 
  73.                             Macman and optionally, how to obtain the C source code.
  74.  
  75.     GAME MENU
  76.  
  77.     Play                    Play one game at the settings chosen.
  78.  
  79.     EDIT MENU
  80.  
  81.     For desk accessories only.  Note: desk accessories can only be used when 
  82.     no game is currently in progress since a mouse click will end a game.
  83.  
  84.     SETTINGS
  85.  
  86.     Turn Sound Off        toggles between "Turn Sound Off" and "Turn Sound On".  
  87.  
  88.     Tweak Speed╔        brings up a dialog box allowing you to adjust (tweak)
  89.                             the speed of the game.  For more, see TECHNICALLY
  90.                             SPEAKING.
  91.     
  92.     Set Controls╔        brings up a dialog box allowing you to customize the
  93.                             direction keys.  Click on the arrow of the direction
  94.                             you want to customize and press the key you want to
  95.                             use.  Click Okay when done.
  96.                             
  97.     The other items correspond to levels of the game.  For example, a game 
  98.     starting at cherries will progress through each level as each board is 
  99.     completed.  Whichever option is checked is the level the game will start 
  100.     at.  Note: key is the highest level, so every level after the key will 
  101.     be another key level.
  102.  
  103.     CHEAT
  104.  
  105.     Three Lives, etc.    whichever option is checked is the number of men you 
  106.                             will start the game with.
  107.  
  108.     Make Invincible    toggles between "Make Invincible" and "Make Vincible." 
  109.                             When Macman is invincible, he can still eat vulnerable 
  110.                             ghosts but he cannot die.  The only way to end a game 
  111.                             if Macman is invincible is with a mouse click.
  112.  
  113.     Four ghosts, etc.    default is four enemy ghosts.  You can adjust this, but
  114.                             you must have at least one (why would you want less?). 
  115.                             
  116.  
  117. PREFERENCES
  118.  
  119. Only the following settings are saved:
  120.  
  121.     1)    Whether the sound is on or off.
  122.     2)    What level you prefer to start at.
  123.     3)    The "tweak" value.
  124.     4)    The keys you choose to control macman.
  125.  
  126. Cheat menu settings are not saved.
  127.  
  128. TECHNICALLY SPEAKING
  129.  
  130. Fast mac owners were understandably impatient that no fix to Macman seemed
  131. to slow the damn thing down.  The culprit:  I was using a simple counting
  132. loop to delay the game.  Countless factors affected the speed of this
  133. counting loop (and those Quadras can count FAST), which made it ultimately
  134. unworkable.  The solution: the revised Time Manager.  A time manager task
  135. is installed in the TM queue.  The task is primed with a delay value of
  136. a number of milliseconds.  Then the game completes one cycle (moves all
  137. characters) and if time has not expired, it waits until time expires before
  138. going on.  Using this method allows Macman to run consistently with all
  139. Macs (within the accuracy limits of the time manager.)  The tweak value is
  140. in milliseconds and is subtracted from the delay value.  Cherries level
  141. (with a tweak value of zero) uses a 25 millisecond delay, which decreases
  142. 1 millisecond per level but never goes below 12 milliseconds.
  143.  
  144. SHAREWARE
  145.  
  146. This game is shareware.  I'm not looking to get rich, but I do ask that 
  147. you send $8 with your name and address to register your copy of Macman if
  148. you like the game or can otherwise find it in your heart to send it. With
  149. your name and address I will notify you of any updates to Macman or other
  150. releases.  (See HOW TO CONTACT THE AUTHOR for my address.)  Share this 
  151. game with whomever you like, but please include this documentation and 
  152. do not distribute altered versions.
  153.  
  154. SOURCE CODE
  155.  
  156. If you are looking for programming techniques or just want to peek under 
  157. the hood, the commented THINK C source code for Macman is available.  It 
  158. may not be the best C code in the world, but it isn't the worst, and it 
  159. does work.
  160.  
  161. For your convenience, you can request the source code three ways. 
  162.     
  163.         1) Send $15 for the code on an 800K floppy
  164.         2) Send $15 for a printout of the code
  165.         3) Send $10 and an 800K floppy for a copy of the code.
  166.         
  167. Please let me know which you want.  This will also register your copy of 
  168. Macman.
  169.  
  170. HOW TO CONTACT THE AUTHOR
  171.  
  172. Any comments, suggestions, complaints, compatibility reports, 
  173. registrations or requests are greatly appreciated and should be sent to 
  174. me at the following address:
  175.  
  176.         John Butler
  177.         2061 Vinton Ave.
  178.         Memphis, TN  38104
  179.  
  180. I can also be contacted on America Online (JohnB42414) or CompuServe
  181. (76366,723).
  182.  
  183. RELEASE HISTORY
  184.  
  185.     3-11-92    Macman 1.0
  186.     3-16-92    Macman 1.0.1    (new option to slow game by varying amounts)
  187.     3-20-92    Macman 1.0.2    (Synchronized the timing to allow consistent
  188.                                      play on all Macs.  A tweak value added to slow
  189.                                      or speed up the game.  Customized directional
  190.                                      control keys added.  Preferences are saved from
  191.                                      game to game.)
  192.                                      
  193. THANK YOU
  194.  
  195. Special thanks to: Andrew Cohen, Jean Tantra, and Michael S. Walborn.